<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>StrokePDF | @magenta/sketch</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">@magenta/sketch</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="../modules/_sketch_rnn_model_.html">&quot;sketch_rnn/model&quot;</a>
				</li>
				<li>
					<a href="_sketch_rnn_model_.strokepdf.html">StrokePDF</a>
				</li>
			</ul>
			<h1>Interface StrokePDF</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Interface for specification of the Probability Distribution Function
						of a pen stroke.</p>
					</div>
					<p>Please refer to &quot;A Neural Representation of Sketch Drawings&quot;
					<a href="https://arxiv.org/abs/1704.03477">https://arxiv.org/abs/1704.03477</a></p>
					<p>In Eq.3 is an explanation of all of these parameters.</p>
					<p>Below is a brief description:</p>
					<dl class="tsd-comment-tags">
						<dt>property</dt>
						<dd><p>pi: categorial distribution for mixture of Gaussian</p>
						</dd>
						<dt>property</dt>
						<dd><p>muX: mean for x-axis</p>
						</dd>
						<dt>property</dt>
						<dd><p>muY: mean for y-axis</p>
						</dd>
						<dt>property</dt>
						<dd><p>sigmaX: standard deviation of x-axis</p>
						</dd>
						<dt>property</dt>
						<dd><p>sigmaY: standard deviation of y-axis</p>
						</dd>
						<dt>property</dt>
						<dd><p>corr: correlation parameter between x and y</p>
						</dd>
						<dt>property</dt>
						<dd><p>pen: categorical distribution for the 3 pen states</p>
						</dd>
					</dl>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">StrokePDF</span>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_sketch_rnn_model_.strokepdf.html#corr" class="tsd-kind-icon">corr</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_sketch_rnn_model_.strokepdf.html#mux" class="tsd-kind-icon">muX</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_sketch_rnn_model_.strokepdf.html#muy" class="tsd-kind-icon">muY</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_sketch_rnn_model_.strokepdf.html#pen" class="tsd-kind-icon">pen</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_sketch_rnn_model_.strokepdf.html#pi" class="tsd-kind-icon">pi</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_sketch_rnn_model_.strokepdf.html#sigmax" class="tsd-kind-icon">sigmaX</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="_sketch_rnn_model_.strokepdf.html#sigmay" class="tsd-kind-icon">sigmaY</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="corr" class="tsd-anchor"></a>
					<h3>corr</h3>
					<div class="tsd-signature tsd-kind-icon">corr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Float32Array</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/sketch/src/sketch_rnn/model.ts#L71">sketch_rnn/model.ts:71</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="mux" class="tsd-anchor"></a>
					<h3>muX</h3>
					<div class="tsd-signature tsd-kind-icon">muX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Float32Array</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/sketch/src/sketch_rnn/model.ts#L67">sketch_rnn/model.ts:67</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="muy" class="tsd-anchor"></a>
					<h3>muY</h3>
					<div class="tsd-signature tsd-kind-icon">muY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Float32Array</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/sketch/src/sketch_rnn/model.ts#L68">sketch_rnn/model.ts:68</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="pen" class="tsd-anchor"></a>
					<h3>pen</h3>
					<div class="tsd-signature tsd-kind-icon">pen<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Float32Array</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/sketch/src/sketch_rnn/model.ts#L72">sketch_rnn/model.ts:72</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="pi" class="tsd-anchor"></a>
					<h3>pi</h3>
					<div class="tsd-signature tsd-kind-icon">pi<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Float32Array</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/sketch/src/sketch_rnn/model.ts#L66">sketch_rnn/model.ts:66</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="sigmax" class="tsd-anchor"></a>
					<h3>sigmaX</h3>
					<div class="tsd-signature tsd-kind-icon">sigmaX<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Float32Array</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/sketch/src/sketch_rnn/model.ts#L69">sketch_rnn/model.ts:69</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="sigmay" class="tsd-anchor"></a>
					<h3>sigmaY</h3>
					<div class="tsd-signature tsd-kind-icon">sigmaY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Float32Array</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/tensorflow/magenta-js/tree/master/sketch/src/sketch_rnn/model.ts#L70">sketch_rnn/model.ts:70</a></li>
						</ul>
					</aside>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class=" tsd-kind-external-module">
						<a href="../modules/_core_sketch_support_.html">"core/sketch_<wbr>support"</a>
					</li>
					<li class="current tsd-kind-external-module">
						<a href="../modules/_sketch_rnn_model_.html">"sketch_<wbr>rnn/model"</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class tsd-parent-kind-external-module">
						<a href="../classes/_sketch_rnn_model_.sketchrnn.html" class="tsd-kind-icon">SketchRNN</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_sketch_rnn_model_.lstmstate.html" class="tsd-kind-icon">LSTMState</a>
					</li>
					<li class=" tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_sketch_rnn_model_.sketchrnninfo.html" class="tsd-kind-icon">SketchRNNInfo</a>
					</li>
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface tsd-parent-kind-external-module">
						<a href="_sketch_rnn_model_.strokepdf.html" class="tsd-kind-icon">StrokePDF</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_sketch_rnn_model_.strokepdf.html#corr" class="tsd-kind-icon">corr</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_sketch_rnn_model_.strokepdf.html#mux" class="tsd-kind-icon">muX</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_sketch_rnn_model_.strokepdf.html#muy" class="tsd-kind-icon">muY</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_sketch_rnn_model_.strokepdf.html#pen" class="tsd-kind-icon">pen</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_sketch_rnn_model_.strokepdf.html#pi" class="tsd-kind-icon">pi</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_sketch_rnn_model_.strokepdf.html#sigmax" class="tsd-kind-icon">sigmaX</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="_sketch_rnn_model_.strokepdf.html#sigmay" class="tsd-kind-icon">sigmaY</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>